Popover: Minimally document the ::closed signal
authorDaniel Boles <dboles.src@gmail.com>
Mon, 5 Nov 2018 23:36:54 +0000 (23:36 +0000)
committerDaniel Boles <dboles.src@gmail.com>
Wed, 7 Nov 2018 20:33:15 +0000 (20:33 +0000)
This is better than nothing at all. The wording is taken from Carlos's
commit message when he added this shortly before 3.12 (but skip Since).
Skip the bit from his commit message explaining what this replaced; we
don't need to say all the less good things our convenience API replaces.

gtk/gtkpopover.c

index cbfa3c99762df090b80f3fabe5a63e8c56a27967..94f234c22306dfc6a90aaccdf73fbc1bbc48c372 100644 (file)
@@ -1650,6 +1650,12 @@ gtk_popover_class_init (GtkPopoverClass *klass)
 
   g_object_class_install_properties (object_class, NUM_PROPERTIES, properties);
 
+  /**
+   * GtkPopover::closed:
+   *
+   * This signal is emitted when the popover is dismissed either through
+   * API or user interaction.
+   */
   signals[CLOSED] =
     g_signal_new (I_("closed"),
                   G_TYPE_FROM_CLASS (object_class),